home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / mail / xsig11.lha / XSig.doc < prev    next >
Text File  |  1994-06-27  |  3KB  |  143 lines
  1. --------------------------------------------------------------------------
  2. $VER: XSIG_Doc 0.4 (26.06.94)
  3. --------------------------------------------------------------------------
  4.  
  5. XSig Documentation
  6. ==================
  7.  
  8. Program and documentation are (C) Copyright 1994 by Jürgen Weinelt.
  9.  
  10. IMPORT StdDisclaimer; (* in short: use it at your own risk *)
  11. XSig was carefully tested, but there's certainly plenty of room for bugs.
  12.  
  13. XSig is Freeware, non-commercial distribution is o.k. as long as the
  14. following conditions are met:
  15.  
  16.   * Source, executable and documentation must be distributed together and
  17.     these files must be intact (you're not allowed to make changes).
  18.     You're NOT allowed to add files to the archive.
  19.  
  20.   * This program may be included on PD/freeware CDs if I am allowed to
  21.     order one of those CDs at 50% off the retail price (or cheaper :).
  22.     Of course a free copy of the CD would be even nicer...
  23.  
  24.     Exception: Fred Fish has UNCONDITIONAL permission to add this
  25.     program version to his library, no matter if he's distributing it
  26.     on floppy disk or on CD.
  27.  
  28.  
  29.  
  30. XSig requires AmigaOS V37 or later (that's 2.04 or later).
  31.  
  32.  
  33.  
  34. Purpose
  35. =======
  36. XSig forms a news/mail signature by combining a fixed (name, address)
  37. and a variable (cookie, funny quote) part. Both parts are selected
  38. depending on a keyword ("group name").
  39.  
  40.  
  41.  
  42. Installation
  43. ============
  44. To create a standard installation of XSig, you need to do the following:
  45.  
  46. - copy the "XSig", "XSigIDX" and "XSigGetGroup" binaries to a directory in
  47.   your search path (preferably "uubin:")
  48. - copy "XSig.data" to "uulib:"
  49. - read _and_understand_ "FileSpecs.txt" ;-)
  50. - edit "uulib:XSig.data"
  51. - create a subdirectory "uulib:XSig"
  52. - copy your cookie file(s) (see FileSpecs.txt) to "uulib:XSig"
  53. - run XSigIDX on your cookie file(s) to create the index and pointer
  54.   file(s)
  55.  
  56. That's it.
  57.  
  58.  
  59.  
  60. Usage
  61. =====
  62. XSig DATA/K,GROUP/K,QUIET/S,STDERR/S,NEXTSIG/S
  63.  
  64. DATA
  65. ----
  66. Selects the config file. Default: uulib:XSig.data
  67.  
  68. GROUP
  69. -----
  70. The cookie selection keyword, a.k.a. "newsgroup name". No default.
  71.  
  72. QUIET
  73. -----
  74. Suppress startup message.
  75.  
  76. STDERR
  77. ------
  78. Send error messages to the CONSOLE: instead of the standard output
  79. stream.
  80.  
  81. NEXTSIG
  82. -------
  83. Get a new cookie; if you omit this, repeated calls to XSig will return
  84. the same cookie over and over again.
  85.  
  86.  
  87.  
  88. Examples
  89. --------
  90. Call "XSig GROUP <groupname> NEXTSIG QUIET" to get a cookie.
  91.  
  92. Use "XSig >>article ..." to append the signature to a posting.
  93.  
  94. Look at the "XSIGEDIT" script. Ideally you just need to set
  95. this as "NEWSEDITOR" in your "uulib:config" file.
  96.  
  97. Put "XSig >uulib:.sig-of-the-day ..." into a crontab to get a new
  98. signature periodically.
  99.  
  100.  
  101.  
  102. History
  103. =======
  104. 1.1     fixed a bug (typo, actually) in the STDERR template. Oops. *blush*
  105. 1.0     (a.k.a. 0.43) first release
  106. 0.37    second beta
  107. 0.35    first beta distribution
  108.  
  109.  
  110.  
  111. Known problems/bugs
  112. ===================
  113. None.
  114.  
  115.  
  116.  
  117. If you have questions or bug reports...
  118. =======================================
  119. You can contact me by eMail:
  120.  
  121.    jow@rz.uni-wuerzburg.de (preferred)
  122.    jow@hcast.franken.de
  123.    jow@hcast.adsp.sub.org (avoid if possible)
  124.  
  125. Or through the snail mail:
  126.  
  127.    Jürgen Weinelt
  128.    Franz-Ludwig-Strasse 10
  129.    D-97072 Würzburg
  130.    Germany
  131.  
  132.  
  133.  
  134. Thanks
  135. ======
  136.  
  137. The following persons reported bugs and/or suggested new features:
  138.  
  139. Michael-Wolfgang Hohmann
  140.    Karl "Charly" Skibinski
  141.  
  142. Thank you.
  143.